home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
ShareWare OnLine 2
/
ShareWare OnLine Volume 2 (CMS Software)(1993).iso
/
database
/
newsltr.zip
/
MANUAL.DOC
< prev
next >
Wrap
Text File
|
1993-01-18
|
26KB
|
569 lines
╒══════════════════════════════════════════════════════════════════╕
│ ╓─╥─╖ ╓───╖ ╓─╖ ╥ ╥ ╥ ╓───╖ ╥ │
│ ║ ╨ ║ ╟───╢ ║ ║ ║ ║ ║ ╟───╢ ║ │
│ ╨ ╨ ╨ ╨ ╨ ╙─╨ ╙───╨ ╨ ╨ ╙───╜ │
│ User Manual for News Letter Reader │
╘══════════════════════════════════════════════════════════════════╛
News Letter Reader Program and Files
Copyright 1992, William E. Collins
All Rights Reserved
Welcome to the 'News Letter Reader'
Warranty, Liability, Damages, Licensing can be found in the LICENSE.DOC
file included.
┌─────────────────────────────────────────────────────────────────────────┐
│ NOTE: If you are using the ANSI Art function to display ANSI Graphics. │
│ Then ANSI.SYS will have to be defined in your CONFIG.SYS boot │
│ file to run them. Your CONFIG.SYS should have an entry that │
│ looks something like "DEVICE = ANSI.SYS" │
└─────────────────────────────────────────────────────────────────────────┘
The News Letter Reader program was created to help people publish a News
Letter quickly and easily by electronic means. The program is not all
encompassing, nor is it overly fancy. However, we believe, it has its own
style and usefulness.
The world of electronic publishing is growing by leaps and bounds on a
daily basis. Some have "On-Line" capabilities, some are downloadable such
as the News Letter Reader program. Many of the News Letter or "Electro-
Mag" programs that have been reviewed during the development of this program
were all very complicated and required a significant outlay of monies in
order to publish. Some even required the receipient to register their copy.
With the News Letter, the receipient is NOT required to register. Only
the publisher needs to register the News Letter program. Additionally
the publisher is allowed to publish one News Letter prior to registration.
Now the publisher can gauge the reaction to his or her publication using
this software. This is in the spirit of the ideals of "Shareware" - try
before you buy.
There are three (3) categories of files for the News Letter Reader. They
are Article, Figure, and Graphic.
Since each News Letter has many Articles and they are the main body of a
News Letter, this is where you start.
Some Articles may have Figures, these are sometimes also known as plates,
insets, tables, and by several other names. This could be either a quote
from another publication, a listing of facts and figures, or program code as
refered to in the article. If you've the time and inclination, you can even
use ANSI Art or graphics for your "Figure."
Additionally quality graphics can be provided with a News Letter. These
are Graphics presented using .GIF/.PCX/.PIC/.TGA files.
NEWS LETTER READER PROGRAM MANUAL Page: 1
┌──────────────┐
│ INSTALLATION │
└──────────────┘
Installation is quite easy. Copy all of the files of the News Letter
program onto your hard disk in the desired directory for operation. Though
slower, the News Letter program will work from a floppy and can be installed
there.
┌──────────────────────────────────────────────────────────────────┐
│ CAUTION: From one News Letter to another, there may be files of │
│ the same name. MAKE SURE YOU BACK UP ALL OF YOUR FILES. │
└──────────────────────────────────────────────────────────────────┘
The News Letter program is not dependent on a directory name nor
specified drive. You may install the News Letter program where you wish.
However, the Default directory and disk must be the one where the file(s)
are located. If you were to install the News Letter program on the "C:"
drive in a directory called "LETTER" your DOS prompt when in that directory
could look something like: C:\LETTER
┌────────────────────────┐
│ VIEWING A NEWS LETTER │
└────────────────────────┘
The entry page will present with a listing of available News Letters.
This list will include the file name of the News Letter Database Index
and a description of the News Letters available. At this time you need
to select the appropriate News Letter Database Index for the News Letter
you wish to review.
Select the News Letter by using the up and down arrows to highlight
your selection, then press return. By pressing the Escape <ESC> key at
this point, you will exit from the program.
┌───────────────────────────────┐
│ COPYRIGHT OR INFORMATION PAGE │
└───────────────────────────────┘
If there is a Copyright or Information page option available. This
will be presented as your page of the News Letter if display is selected
in the Configuration File.
If ANSI Art is used and properly coded, you will be presented with ANSI
Graphics. Otherwise you will be presented with text information.
To review text information, pressing the up and down arrows to review
the Copyright information as needed. To continue in either case, press the
escape <ESC> key.
NEWS LETTER READER PROGRAM MANUAL Page: 2
┌────────────────────┐
│ VIEWING AN ARTICLE │
└────────────────────┘
Upon continuing after the Copyright screen, you will be presented with
a listing of articles. Use the arrow keys to highlight your selection,
then press the "Enter" key to be presented that article. Use the <ESC> key
to return to the News Letter file availability listing.
You will be presented with your article. Use the up and down arrows to
move through the article. Use the <ESC> key to return to the News Letter
article availability listing.
┌──────────────┐
│ FIGURE FILES │
└──────────────┘
At some time you may see in the upper left corner a blinking red
notation of "Figures." This means that there are Figure files available for
reference. To look at a listing of these, press the "F2" key. You will
then be presented with a listing of the Figures available. Select the
desired figure in the same manner as you have in both the News Letter
selection and Article selection. The selected "Figure" will popup on the
screen as a box overlaying your article. To return to your Article, press
the <ESC> key.
Where ANSI Art graphics are properly coded and used, your screen will
be cleared and the ANSIART will be displayed. Upon exiting the ANSI Art
page, you will be presented with a partial page of the "Figure" text.
This will seem to be a jumble of unrecognised "stuff" including arrows,
semi-colons, numbers, alpha characters, and left hand brackets. To return
to your Article, press the <ESC> key.
┌───────────────┐
│ GRAPHIC FILES │
└───────────────┘
At some time you may see in the upper right corner a red blinking
notation of "Graphics." This means that there are Graphic files available
for viewing. To look at a listing of these, press the "F3" key. You will
then be presented with a listing of the Graphics available. Select in the
same manner as you have in both the News Letter selection and Article
selection.
The selected "Graphic" will be displayed on the screen, temporarily
replacing the current article displayed. To return to your Article, press
any key or allow the system to "time out."
NEWS LETTER READER PROGRAM MANUAL Page: 3
┌────────────┐
│ CALCULATOR │
└────────────┘
What can you say about a calculator? It's a calculator with a decimal
point. You can use it if needed to test some formula in a News Letter, or
even total up something that was noted and you want to check. You can
even balance your check book to see if you can afford something you've
just read about.
┌───────────────────────────────┐
│ PRINTING AN ARTICLE OR FIGURE │
└───────────────────────────────┘
By selecting the "Print" (F4 Key) option, you will create a hard copy
of the selected file, giving the reader the ability to save the information
or read at a later date/time. Upon pressing "F4" the file will be
sent to your printer.
To print a "Figure" or an "Article" file, you must be viewing that file
at the time you press the "F4" key.
The format is normal ASCII Text mode. Some character may not print
because of being a part of the extended ASCII character group. To print
these, you must have your printer ready to accept the extended ASCII
characters. Frequently in dot matrix printers this is the "Graphic" mode.
In the case of HP compatible laser printers, you will have to select the
appropriate font group that will allow these extended characters.
┌───────────────────────────────┐
│ STARTING YOUR OWN NEWS LETTER │
└───────────────────────────────┘
To start your own News Letter, erase the "LETTER.FIG" file, then all
files not listed in the "FILES.DOC."
When you have deleted the "LETTER.FIG" and restart the News Letter
Program, you will now have a "virgin" or "clean" system that you can
load-up with your articles, figures and graphics. To start the News
Letter you type "LETTER LOADER."
┌──────────────────────┐
│ NEWSLETTER EXECUTION │
└──────────────────────┘
There are three ways to execute the News Letter Program. You may
execute by typing "LETTER, LETTER CONFIG, or LETTER LOADER."
By executing with no extention, "LETTER", you will enter the News
Letter proper. At this time, if the "LETTER.FIG" file is missing, you
will be presented with a new configuration file. It will be listed as
NEWS LETTER READER PROGRAM MANUAL Page: 4
unregistered and without registration number. The 25/50 line option will
be defaulted to a 25 line display and the Copyright display will be
defaulted to "Yes."
By executing with the "LETTER CONFIG" option, you will initially enter
the Configuration section as described above. This will allow you to
change the 25/50 line option and the default display of a Copyright screen.
Executing with the "LETTER LOADER" option, will express you to the
functions that will allow you to "Load" a News Letter. If the "LETTER.FIG"
file is missing, you will be forwarded to this section for completion prior
to loading, editing and deleting files.
┌─────────────────────┐
│ NEWS LETTER LOADING │
└─────────────────────┘
To load a News Letter, you need to do a little planning. Your articles
should be seperate ASCII files. Additionally, any Figure files that you
will be including need to also be separate files.
┌─────────────────┐
│FILE PREPARATION:│
└─────────────────┘
Going through each text file, the line length should be no more
than 76 characters across. Otherwise you may run into display
problems where the line length conflicts with page width. Maximum
length of a text file is 64,000 bytes (or 64k).
If you are using ANSI Art for either your Copyright screen or one
of the Figure files. You will need to enter on the first line, without
any codes, one of the following; "[ANSIART,25] or [ANSIART,50]" This
will automatically trigger the ANSI Art function and display the ANSI
Art. The latter numbers ",25" or ",50" indicates the number of lines
to be used for display. If the ",50" is used, the program will change
the mode from 25 line display to 50 line display and back at the
termination of the display. If you are already in 50 line display,
the mode will not change and will continue after termination of the
ANSI Art.
┌─────────────────────────────────────────┐
│ The following are file extentions not │
│ recognized by the loading program │
│ in it's file selection list(s). │
│ │
│ .SYS .TGA .PIC .NTX │
│ .COM .EXE .GIF .BAK │
│ .PCX .NDX .OBJ .WK1 │
└─────────────────────────────────────────┘
┌───────────────────────────────────────────────────┐
│ NOTE: You will also require the ANSI.SYS to be │
│ designated as a "DEVICE" in your boot CONFIG.SYS. │
└───────────────────────────────────────────────────┘
NEWS LETTER READER PROGRAM MANUAL Page: 5
┌──────────────────────────────┐
│OPENING A NEW DATABASE INDEX: │
└──────────────────────────────┘
To open a new data base index, select the MASTER.DBF from the database
which is the selection menu, this is a template for all index databases.
Using the Master database index as a template, a new index is opened.
┌───────────────────────┐
│NAMING DATABASE INDEX: │
└───────────────────────┘
Your first action will be to re-name this index to a name that is unique
to your news letter or magazine. When you are presented with the below box
on the screen, enter your new index name. Ensure that you include the
".DBF" as the last four characters. The first eight may be an alpha or
numeric character. Spaces are not allowed between other characters. It is
best to not include any spaces. If your new name is less than eight
characters, move the period "." and the "DBF" to the left and enter like
this: "XXX.DBF"
Upon completion of your naming action, you will be returned to the
database selection menu. To continue you will need to select your new
index database.
┌───────────────────────────────────────────────┐
│ Enter the Name of New Data Base: │
│ │
│ NEWFILE.DBF░ │
│ │
└───────────────────────────────────────────────┘
┌─────────────────────────┐
│NEWS LETTER DESCRIPTION: │
└─────────────────────────┘
If you have not previously entered the description of your news letter
or magazine, you will be shunted to the description panel for your entry.
Give a short description of your news letter or magazine. This description
will be shown when your readers enter the News Letter Reader program.
┌──────────────────────────────────────────────────────────┐
│ Enter the Title of the Newsletter: │
-=> │ ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │
│ Enter Copyright File Name: ░░░░░░░░░░░░ │
│ │
│ Enter Exit Screen File Name: ░░░░░░░░░░░░ │
└──────────────────────────────────────────────────────────┘
NEWS LETTER READER PROGRAM MANUAL Page: 6
If you have already completed the description and addressed your
Copyright file name and Exit Screen name, you can re-enter this feature from
your main loader menu by selecting the "News Letter Descripton" option.
<DATABASE INDEX FILE NAME>
│
└─── News Letter Description
┌────────────────┐
│COPYRIGHT FILE: │
└────────────────┘
There are two additional blanks. The first is to name a Copyright File
name. This file will be presented upon entry to your news letter or
magazine this file may either be a text file or an ANSI Art file. Don't
worry, if you don't want to use one, the program will just skip this feature
if you don't include a file name.
┌──────────────────────────────────────────────────────────┐
│ Enter the Title of the Newsletter: │
│ ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │
-=> │ Enter Copyright File Name: ░░░░░░░░░░░░ │
│ │
│ Enter Exit Screen File Name: ░░░░░░░░░░░░ │
└──────────────────────────────────────────────────────────┘
┌────────────────┐
│LAST PAGE FILE: │
└────────────────┘
This is a feature wher you can take one last opportunity to plug your
news letter or magazine. You could even give a plug for your favorite BBS,
book or pearls of wisdom. But don't worry, if you don't want to use this
feature, the program will just skip this on by this feature if you don't
include a file name.
┌──────────────────────────────────────────────────────────┐
│ Enter the Title of the Newsletter: │
│ ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │
│ Enter Copyright File Name: ░░░░░░░░░░░░ │
│ │
-=> │ Enter Exit Screen File Name: ░░░░░░░░░░░░ │
└──────────────────────────────────────────────────────────┘
NEWS LETTER READER PROGRAM MANUAL Page: 7
┌──────────────────────────────────────────────────────┐
│ADDING ARTICLES, FIGURES, AND GRAPHIC FILES TO INDEX: │
└──────────────────────────────────────────────────────┘
To add an article, Figure or Graphic, select the "Article, Figure, or
Graphic." Then select the "Add" feature. Upon selection of this feature,
you must now be sure to select the proper type of addition you want. The
Article is the main feature of this program, all other files are centered
aroud this article. Both the Figure files, and the Graphic files are treed
from an Article.
<DATABASE INDEX FILE NAME>
│
└─── Article, Figure, or Graphic
│
└─── Add
│
├─── Article
│ └─── Article/Figure/Graphic File Listing
│ (select by pressing <Enter>)
├─── Figure
│ └─── Article/Figure/Graphic File Listing
│ (select by pressing <Enter>)
└─── Graphic
└─── Article/Figure/Graphic File Listing
(select by pressing <Enter>)
After Selecting the type of file, you will be shunted to one of two
actions. If you have selected to add an Article, you will next be asked to
select the file name to become that article. Upon the selection of a file,
you will be given the below panel on the screen. You will need to do two
things, first describe for the index, what the file is about. Then ensure
that the file name entered below the description is the proper one for the
Article.
If you have selected to add either a Figure or a Graphic file, you will
first be asked to select the proper Article to be attached to. Next you
will have to provide the name of the file to attach by selecting it from a
file listing.
┌──────────────────────────────────────────────────────────┐
│ File Description │
│ ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │
│ │
│ File Name: ░░░░░░░░░░░░ │
└──────────────────────────────────────────────────────────┘
┌─────────────────────────────────────────┐
│ The following are file extentions not │
│ recognized by the loading program │
│ in it's file selection list(s). │
│ │
│ .SYS .TGA .PIC .NTX │
│ .COM .EXE .GIF .BAK │
│ .PCX .NDX .OBJ .WK1 │
└─────────────────────────────────────────┘
NEWS LETTER READER PROGRAM MANUAL Page: 8
A note needs to be entered here concerning the use of graphic files.
Graphic files are significantly hardware dependent. Screen displays for a
computer whether they be SVGA, VGA, EGA, or CGA for example are very
different. Most of the problems will center around the "quality" of the
graphic display capabilities in colour and resolution. Your graphic file
must be targeted to the audiance. Though you will frequently run into users
that will not be able to display the graphic file you display. You may wish
to tailor a graphic file for each type display.
┌─────────────────────────────────────────────────┐
│EDITING ARTICLE, FIGURE, OR GRAPHIC DESCRIPTION: │
└─────────────────────────────────────────────────┘
When you select the Edit feature, you will be presented a listing of
the descriptions for all the articles, figures and graphic index elements.
Select this entry you wish to Edit.
<DATABASE INDEX FILE NAME>
│
└─── Article, Figure, or Graphic
│
└─── Edit
│
└─── Article/Figure/Graphic File Listing
(select by pressing <Enter>)
Upon selection you will be presented the following panel for your edit
needs. You will not be able to actually edit the article from the News
Letter Reader program, only the description of the file and the file name.
┌──────────────────────────────────────────────────────────┐
│ File Description │
│ ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │
│ │
│ File Name: ░░░░░░░░░░░░ │
└──────────────────────────────────────────────────────────┘
┌─────────────────────────────────────────┐
│ The following are file extentions not │
│ recognized by the loading program │
│ in it's file selection list(s). │
│ │
│ .SYS .TGA .PIC .NTX │
│ .COM .EXE .GIF .BAK │
│ .PCX .NDX .OBJ .WK1 │
└─────────────────────────────────────────┘
NEWS LETTER READER PROGRAM MANUAL Page: 9
┌─────────────────────────────────────────────────────┐
│DELETEING AN ARTICLE, FIGURE OR GRAPHIC INDEX ENTRY: │
└─────────────────────────────────────────────────────┘
<DATABASE INDEX FILE NAME>
│
└─── Article, Figure, or Graphic
│
└─── Delete
│
└─── Article/Figure/Graphic File Listing
(select by pressing <Enter>)
When you select the option to delete a file, you will be asked to select
the index selection you wish to delete. When you select this index
selection to delete, you will be presented with the two panels below.
Additionally you will be asked to confirm this desire to delete a index
selection.
┌──────────────────────────────────────────────────────────┐
│ File Description │
│ ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │
│ │
│ File Name: ░░░░░░░░░░░░ │
└──────────────────────────────────────────────────────────┘
┌───────────────────────────┐
│ Are you SURE you want to │
│ DELETE? │
│ YES NO │
└───────────────────────────┘
If you confirm this deletion, you will delete the Article, Figure or
Graphic index entry. If you have some Figure and/or Graphic files attached
to an Article, those too will be deleted. Be careful on what you delete.
┌──────────────────────┐
│ CODING FOR ANSI ART: │
└──────────────────────┘
To code an ANSI Art file for execution, you must put one of the following
entries on the first line of the ASCII file:
[ANSIART,25] or [ANSIART,50]
Entering [ANSIART,25] will display a 25 line ANSI Art file. Entering
[ANSIART,50] will display a 50 line ANSI Art file. There should be no other
entries on this first line. You can also display an ANSI Art file type file
by typing "TYPE <FILE NAME>" from the DOS prompt.
┌───────────────────────────────────────────────────┐
│ NOTE: You will also require the ANSI.SYS to be │
│ designated as a "DEVICE" in your boot CONFIG.SYS. │
│ │
│ EXAMPLE: "DEVICE=ANSI.SYS" │
└───────────────────────────────────────────────────┘
NEWS LETTER READER PROGRAM MANUAL Page: 10